Loading...
 

CX_STRUCTURE - Structures (levels)

CX_STRUCTURE

Class hierarchy
Description:

This class is used to organise business objects into structures (levels) or categories. These are hierarchical.

To structure objects, a hierarchical structure is built using CX_STRUCTURE objects. The connection between the structure and the objects is established via the fixed data field "cast". Each CX_STRUCTURE object now points to the object that is included in the newly created structure.

To categorise objects, they are hierarchically linked to each other via the fixed data field "structures". Each of these objects must be derived from CX_STRUCTURED for this purpose.

Code example:
...
List of methods (MDI)
Function MA* Parameters Return Brief description
CheckAbove OBJECT Trigger error if structure is superior
DeepAddObj STRING, OBJECT OBJECT Adds up, for all child elements, the results of a given function with an object as a parameter.
DeepAddObjIntObj STRING, OBJECT, INTEGER, INTEGER, OBJECT OBJECT Adds up, for all child elements, the results of a given function with two integers and two objects as parameters.
DeepAddObjIntObj STRING, OBJECT, INTEGER, OBJECT OBJECT Adds up, for all child elements, the results of a given function with integer and two objects as parameters.
DeepAddVoid STRING OBJECT Adds up the results of a given function for all subordinate elements.
Description STRING Name of this object
InsertAfter OBJECT, OBJECT Inserts an element after a given element
InsertBefore OBJECT, OBJECT Inserts an element before a given element
InsertFirst OBJECT Adds the element as the first in the list of child elements
InsertLast OBJECT Inserts the element last in the list of child elements
InsertLevelAbove OBJECT Insert a new layer above the layer
InsertLevelBelow OBJECT Insert a new layer between the layer and subordinate elements
LevelAboveBottom INTEGERReturns the plane depth "seen from below".
LevelBelowTop INTEGERReturns the plane depth "seen from above".
Object STRING, INTEGER OBJECT Object of a particular type from the list of child elements.
Objects INTEGER COLLECTION Returns all elements up to a given level
RemoveLevel Removes the level from the hierarchy
SanityCheck INTEGERCheck for consistency of the object
ShortName STRING Short name of this object
Top OBJECT Returns the top level
Total STRING OBJECT ?
UniqueID STRING Content of the fixed data field "uniqueID".
UpperStructureByCondition STRING OBJECT Higher-level structure that satisfies a particular condition
ClassFilter STRING, INTEGER OBJECT This object, if it corresponds to a particular class
ConnectStateStructure OBJECT, STRING Connect to the status structure
Deleted INTEGERObject marked as deleted?
EvaluateTotal STRING OBJECT Calculate formula
ForceMonitor STRING OBJECT ?
GetDomain INTEGERDomain of this object
GetSiblings COLLECTION All siblings of this object
GetSiblings2 COLLECTION All siblings of this object
GetSlotEntries VECTOR<OBJECT> Return of internal information on slots
InsertMonitor OBJECT ?
LastUpdate OBJECT Date of the last write access
LastUser INTEGERUser who last had write access to the object
Link OBJECT Add this object to the list of objects with validity
Monitor STRING OBJECT ?
NextValidObject OBJECT Temporally subsequent validity object
PreviousValidObject OBJECT Temporally preceding validity object
RemoveMonitor OBJECT ?
RemoveStateStructure STRING Find status structure according to uniqueID and release connection
RestrictedValidity * Validity range restricted?
SetDomain INTEGER, INTEGER Set domain
Siblings * Objects with validity
SpanDateValidity * Validity range
StateStructure STRING OBJECT Find state structure by uniqueID (STRING) (not wrapped).
StateStructureWrapper STRING OBJECT Find state structure by uniqueID
string INTEGER CX_STRING Returns the string representation of the object
TriggeredStateStructure STRING OBJECT Tries to switch state structure further and returns the new state structure(not wrapped).
TriggeredStateStructureWrapper STRING OBJECT Tries to switch state structure further and returns the new state structure(wrapped).
TriggerStateStructures Advances all status structures
Unlink Remove this object from the list of objects with validity
Unlink2 Remove this object from the list of objects with validity
Valid OBJECT INTEGERCheck validity
ValidSince OBJECT Start of the validity range
ValidToday INTEGERValid today?
ValidUntil OBJECT End of the validity range
VerifySiblings INTEGERCheck ring of exchange objects

* MA = member access function,
greyed out = inherited function

Data directory (DDI)
Data field Type Reference class I* Brief description
attributeSet POINTER CX_ATTRIBUTE_SET Attribute table describing slots in more detail.
cast REL_1M CX_STRUCTURED Cross connection, roll
masterStructure REL_1M CX_STRUCTURED Parent structure
structureEnum ENUMSHORT Type of structure
structures REL_MN CX_EXPANDABLE Organisational structures
uniqueID STRING * Unique key
validity POINTER CX_VALIDITY Validity period of the object

* I = Indexable data field,
greyed out = inherited data field.

Use in AppsWH
Module Brief description
structur.mod Basic module structure
strucedt.mod Structure editing module
strucsel.mod Structure selection module
pcalcgrp.mod Pricing group basic module
pcalcedt.mod Pricing group Editing module
pcalcsel.mod Pricing group Selection module
custoedt.mod Customer editing module
repreedt.mod Representative editing module
advatsta.mod advatsta.htm | alarmclk.htm Advance turnover tax return